<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.9.2" />
<title>graia.application.interrupts API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>graia.application.interrupts</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">from typing import Callable, Optional, Union
from graia.broadcast.exceptions import ExecutionStop
from graia.broadcast.interrupt.waiter import Waiter
from graia.application.group import Group, Member
from graia.application.message.elements.internal import Quote, Source
from graia.application.message import BotMessage
from graia.application.event.messages import FriendMessage, GroupMessage, TempMessage
from graia.application.friend import Friend


def GroupMessageInterrupt(
    special_group: Optional[Union[Group, int]] = None,
    special_member: Optional[Union[Member, int]] = None,
    quote_access: Optional[Union[BotMessage, Source]] = None,
    custom_judgement: Optional[Callable[[GroupMessage], bool]] = None,
    block_propagation: bool = False,
):
    @Waiter.create_using_function([GroupMessage], block_propagation=block_propagation)
    def GroupMessageInterruptWaiter(event: GroupMessage):
        if special_group:
            if event.sender.group.id != (
                special_group.id if isinstance(special_group, Group) else special_group
            ):
                raise ExecutionStop()
        if special_member:
            if event.sender.id != (
                special_member.id
                if isinstance(special_member, Member)
                else special_member
            ):
                raise ExecutionStop()
        if quote_access:
            quotes = event.messageChain.get(Quote)
            if not quotes:
                raise ExecutionStop()
            quote: Quote = quotes[0]
            if isinstance(quote_access, BotMessage):
                if quote.id != quote_access.messageId:
                    raise ExecutionStop()
            elif isinstance(quote_access, Source):
                if quote.id != quote_access.id:
                    raise ExecutionStop()
        if custom_judgement:
            if not custom_judgement(event):
                raise ExecutionStop()
        return event

    return GroupMessageInterruptWaiter


def FriendMessageInterrupt(
    special_friend: Optional[Union[Friend, int]] = None,
    quote_access: Optional[Union[BotMessage, Source]] = None,
    custom_judgement: Optional[Callable[[FriendMessage], bool]] = None,
    block_propagation: bool = False,
):
    @Waiter.create_using_function([FriendMessage], block_propagation=block_propagation)
    def FriendMessageInterruptWaiter(event: FriendMessage):
        if special_friend:
            if event.sender.id != (
                special_friend.id
                if isinstance(special_friend, Friend)
                else special_friend
            ):
                raise ExecutionStop()
        if quote_access:
            quotes = event.messageChain.get(Quote)
            if not quotes:
                raise ExecutionStop()
            quote: Quote = quotes[0]
            if isinstance(quote_access, BotMessage):
                if quote.id != quote_access.messageId:
                    raise ExecutionStop()
            elif isinstance(quote_access, Source):
                if quote.id != quote_access.id:
                    raise ExecutionStop()
        if custom_judgement:
            if not custom_judgement(event):
                raise ExecutionStop()
        return event

    return FriendMessageInterruptWaiter


def TempMessageInterrupt(
    special_group: Optional[Union[Group, int]] = None,
    special_member: Optional[Union[Member, int]] = None,
    quote_access: Optional[Union[BotMessage, Source]] = None,
    custom_judgement: Optional[Callable[[TempMessage], bool]] = None,
    block_propagation: bool = False,
):
    @Waiter.create_using_function([TempMessage], block_propagation=block_propagation)
    def TempMessageInterruptWaiter(event: TempMessage):
        if special_group:
            if event.sender.group.id != (
                special_group.id if isinstance(special_group, Group) else special_group
            ):
                raise ExecutionStop()
        if special_member:
            if event.sender.id != (
                special_member.id
                if isinstance(special_member, Member)
                else special_member
            ):
                raise ExecutionStop()
        if quote_access:
            quotes = event.messageChain.get(Quote)
            if not quotes:
                raise ExecutionStop()
            quote: Quote = quotes[0]
            if isinstance(quote_access, BotMessage):
                if quote.id != quote_access.messageId:
                    raise ExecutionStop()
            elif isinstance(quote_access, Source):
                if quote.id != quote_access.id:
                    raise ExecutionStop()
        if custom_judgement:
            if not custom_judgement(event):
                raise ExecutionStop()
        return event

    return TempMessageInterruptWaiter</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="graia.application.interrupts.FriendMessageInterrupt"><code class="name flex">
<span>def <span class="ident">FriendMessageInterrupt</span></span>(<span>special_friend: Union[<a title="graia.application.friend.Friend" href="friend.html#graia.application.friend.Friend">Friend</a>, int, NoneType] = None, quote_access: Union[<a title="graia.application.message.BotMessage" href="message/index.html#graia.application.message.BotMessage">BotMessage</a>, <a title="graia.application.message.elements.internal.Source" href="message/elements/internal.html#graia.application.message.elements.internal.Source">Source</a>, NoneType] = None, custom_judgement: Union[Callable[[<a title="graia.application.event.messages.FriendMessage" href="event/messages.html#graia.application.event.messages.FriendMessage">FriendMessage</a>], bool], NoneType] = None, block_propagation: bool = False)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def FriendMessageInterrupt(
    special_friend: Optional[Union[Friend, int]] = None,
    quote_access: Optional[Union[BotMessage, Source]] = None,
    custom_judgement: Optional[Callable[[FriendMessage], bool]] = None,
    block_propagation: bool = False,
):
    @Waiter.create_using_function([FriendMessage], block_propagation=block_propagation)
    def FriendMessageInterruptWaiter(event: FriendMessage):
        if special_friend:
            if event.sender.id != (
                special_friend.id
                if isinstance(special_friend, Friend)
                else special_friend
            ):
                raise ExecutionStop()
        if quote_access:
            quotes = event.messageChain.get(Quote)
            if not quotes:
                raise ExecutionStop()
            quote: Quote = quotes[0]
            if isinstance(quote_access, BotMessage):
                if quote.id != quote_access.messageId:
                    raise ExecutionStop()
            elif isinstance(quote_access, Source):
                if quote.id != quote_access.id:
                    raise ExecutionStop()
        if custom_judgement:
            if not custom_judgement(event):
                raise ExecutionStop()
        return event

    return FriendMessageInterruptWaiter</code></pre>
</details>
</dd>
<dt id="graia.application.interrupts.GroupMessageInterrupt"><code class="name flex">
<span>def <span class="ident">GroupMessageInterrupt</span></span>(<span>special_group: Union[<a title="graia.application.group.Group" href="group.html#graia.application.group.Group">Group</a>, int, NoneType] = None, special_member: Union[<a title="graia.application.group.Member" href="group.html#graia.application.group.Member">Member</a>, int, NoneType] = None, quote_access: Union[<a title="graia.application.message.BotMessage" href="message/index.html#graia.application.message.BotMessage">BotMessage</a>, <a title="graia.application.message.elements.internal.Source" href="message/elements/internal.html#graia.application.message.elements.internal.Source">Source</a>, NoneType] = None, custom_judgement: Union[Callable[[<a title="graia.application.event.messages.GroupMessage" href="event/messages.html#graia.application.event.messages.GroupMessage">GroupMessage</a>], bool], NoneType] = None, block_propagation: bool = False)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def GroupMessageInterrupt(
    special_group: Optional[Union[Group, int]] = None,
    special_member: Optional[Union[Member, int]] = None,
    quote_access: Optional[Union[BotMessage, Source]] = None,
    custom_judgement: Optional[Callable[[GroupMessage], bool]] = None,
    block_propagation: bool = False,
):
    @Waiter.create_using_function([GroupMessage], block_propagation=block_propagation)
    def GroupMessageInterruptWaiter(event: GroupMessage):
        if special_group:
            if event.sender.group.id != (
                special_group.id if isinstance(special_group, Group) else special_group
            ):
                raise ExecutionStop()
        if special_member:
            if event.sender.id != (
                special_member.id
                if isinstance(special_member, Member)
                else special_member
            ):
                raise ExecutionStop()
        if quote_access:
            quotes = event.messageChain.get(Quote)
            if not quotes:
                raise ExecutionStop()
            quote: Quote = quotes[0]
            if isinstance(quote_access, BotMessage):
                if quote.id != quote_access.messageId:
                    raise ExecutionStop()
            elif isinstance(quote_access, Source):
                if quote.id != quote_access.id:
                    raise ExecutionStop()
        if custom_judgement:
            if not custom_judgement(event):
                raise ExecutionStop()
        return event

    return GroupMessageInterruptWaiter</code></pre>
</details>
</dd>
<dt id="graia.application.interrupts.TempMessageInterrupt"><code class="name flex">
<span>def <span class="ident">TempMessageInterrupt</span></span>(<span>special_group: Union[<a title="graia.application.group.Group" href="group.html#graia.application.group.Group">Group</a>, int, NoneType] = None, special_member: Union[<a title="graia.application.group.Member" href="group.html#graia.application.group.Member">Member</a>, int, NoneType] = None, quote_access: Union[<a title="graia.application.message.BotMessage" href="message/index.html#graia.application.message.BotMessage">BotMessage</a>, <a title="graia.application.message.elements.internal.Source" href="message/elements/internal.html#graia.application.message.elements.internal.Source">Source</a>, NoneType] = None, custom_judgement: Union[Callable[[<a title="graia.application.event.messages.TempMessage" href="event/messages.html#graia.application.event.messages.TempMessage">TempMessage</a>], bool], NoneType] = None, block_propagation: bool = False)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def TempMessageInterrupt(
    special_group: Optional[Union[Group, int]] = None,
    special_member: Optional[Union[Member, int]] = None,
    quote_access: Optional[Union[BotMessage, Source]] = None,
    custom_judgement: Optional[Callable[[TempMessage], bool]] = None,
    block_propagation: bool = False,
):
    @Waiter.create_using_function([TempMessage], block_propagation=block_propagation)
    def TempMessageInterruptWaiter(event: TempMessage):
        if special_group:
            if event.sender.group.id != (
                special_group.id if isinstance(special_group, Group) else special_group
            ):
                raise ExecutionStop()
        if special_member:
            if event.sender.id != (
                special_member.id
                if isinstance(special_member, Member)
                else special_member
            ):
                raise ExecutionStop()
        if quote_access:
            quotes = event.messageChain.get(Quote)
            if not quotes:
                raise ExecutionStop()
            quote: Quote = quotes[0]
            if isinstance(quote_access, BotMessage):
                if quote.id != quote_access.messageId:
                    raise ExecutionStop()
            elif isinstance(quote_access, Source):
                if quote.id != quote_access.id:
                    raise ExecutionStop()
        if custom_judgement:
            if not custom_judgement(event):
                raise ExecutionStop()
        return event

    return TempMessageInterruptWaiter</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="graia.application" href="index.html">graia.application</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="graia.application.interrupts.FriendMessageInterrupt" href="#graia.application.interrupts.FriendMessageInterrupt">FriendMessageInterrupt</a></code></li>
<li><code><a title="graia.application.interrupts.GroupMessageInterrupt" href="#graia.application.interrupts.GroupMessageInterrupt">GroupMessageInterrupt</a></code></li>
<li><code><a title="graia.application.interrupts.TempMessageInterrupt" href="#graia.application.interrupts.TempMessageInterrupt">TempMessageInterrupt</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
</footer>
</body>
</html>